Fix up some doc comments to shut up gtk-doc.

2007-11-26  Matthias Clasen  <mclasen@redhat.com>

        * gtk/gtkmain.c:
        * gtk/gtknotebook.c:
        * gtk/gtkplugprivate.h:
        * gtk/gtksocket.c:
        * gtk/gtksocketprivate.h:
        * gtk/gtktable.c: Fix up some doc comments to shut up gtk-doc.

svn path=/trunk/; revision=19066

diff --git a/ChangeLog b/ChangeLog
index c387610221270079cd2c95011357e56a9c86c203..ac6fc00c7414c254117c9ee19aa8edaac9838f32 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2007-11-26  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkmain.c:
+       * gtk/gtknotebook.c:
+       * gtk/gtkplugprivate.h:
+       * gtk/gtksocket.c:
+       * gtk/gtksocketprivate.h:
+       * gtk/gtktable.c: Fix up some doc comments to shut up gtk-doc.
+
 2007-11-26  Matthias Clasen  <mclasen@redhat.com>
 
        * configure.in: Use $CUPS_CONFIG instead of hardcoded cups-config.

diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 0c7702ae5e745ab076b67123aafb27c34db6e64d..c645a084e46d18c544c1a590e5e14047eef9ddb3 100644 (file)
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -731,7 +731,7 @@ post_parse_hook (GOptionContext *context,
  * with g_option_context_add_group(), if you are using 
  * g_option_context_parse() to parse your commandline arguments.
  *
- * Returns a #GOptionGroup for the commandline arguments recognized
+ * Returns: a #GOptionGroup for the commandline arguments recognized
  *   by GTK+
  *
  * Since: 2.6

diff --git a/gtk/gtknotebook.c b/gtk/gtknotebook.c
index c78a9a84da9a840ee1eef2a01a84ba7dc06f0837..445ed9500015480e82fda6cefd872129e1ee8a11 100644 (file)
--- a/gtk/gtknotebook.c
+++ b/gtk/gtknotebook.c
@@ -6970,10 +6970,10 @@ gtk_notebook_set_tab_label_text (GtkNotebook *notebook,
  * Retrieves the text of the tab label for the page containing
  *    @child.
  *
- * Returns value: the text of the tab label, or %NULL if the
- *                tab label widget is not a #GtkLabel. The
- *                string is owned by the widget and must not
- *                be freed.
+ * Return value: the text of the tab label, or %NULL if the
+ *               tab label widget is not a #GtkLabel. The
+ *               string is owned by the widget and must not
+ *               be freed.
  **/
 G_CONST_RETURN gchar *
 gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
@@ -7104,11 +7104,11 @@ gtk_notebook_set_menu_label_text (GtkNotebook *notebook,
  * Retrieves the text of the menu label for the page containing
  *    @child.
  *
- * Returns value: the text of the tab label, or %NULL if the
- *                widget does not have a menu label other than
- *                the default menu label, or the menu label widget
- *                is not a #GtkLabel. The string is owned by
- *                the widget and must not be freed.
+ * Return value: the text of the tab label, or %NULL if the
+ *               widget does not have a menu label other than
+ *               the default menu label, or the menu label widget
+ *               is not a #GtkLabel. The string is owned by
+ *               the widget and must not be freed.
  **/
 G_CONST_RETURN gchar *
 gtk_notebook_get_menu_label_text (GtkNotebook *notebook,

diff --git a/gtk/gtkplugprivate.h b/gtk/gtkplugprivate.h
index fb173c13408eef9ace8b7a5a960139656f9fc0f3..74f0374bc5b820f939eed6b05ce8056abca584e1 100644 (file)
--- a/gtk/gtkplugprivate.h
+++ b/gtk/gtkplugprivate.h
@@ -36,7 +36,7 @@ void _gtk_plug_handle_modality_off    (GtkPlug          *plug);
 
 /* In backend-specific file: */
 
-/**
+/*
  * _gtk_plug_windowing_get_id:
  *
  * @plug: a #GtkPlug
@@ -45,7 +45,7 @@ void _gtk_plug_handle_modality_off    (GtkPlug          *plug);
  */
 GdkNativeWindow _gtk_plug_windowing_get_id (GtkPlug *plug);
 
-/**
+/*
  * _gtk_plug_windowing_realize_toplevel:
  *
  * @plug_window: a #GtkPlug's #GdkWindow
@@ -55,7 +55,7 @@ GdkNativeWindow _gtk_plug_windowing_get_id (GtkPlug *plug);
  */
 void _gtk_plug_windowing_realize_toplevel (GtkPlug *plug);
 
-/**
+/*
  * _gtk_plug_windowing_map_toplevel:
  *
  * @plug: a #GtkPlug
@@ -65,7 +65,7 @@ void _gtk_plug_windowing_realize_toplevel (GtkPlug *plug);
  */
 void _gtk_plug_windowing_map_toplevel (GtkPlug *plug);
 
-/**
+/*
  * _gtk_plug_windowing_map_toplevel:
  *
  * @plug: a #GtkPlug
@@ -75,7 +75,7 @@ void _gtk_plug_windowing_map_toplevel (GtkPlug *plug);
  */
 void _gtk_plug_windowing_unmap_toplevel (GtkPlug *plug);
 
-/**
+/*
  * _gtk_plug_windowing_set_focus:
  *
  * @plug: a #GtkPlug
@@ -85,7 +85,7 @@ void _gtk_plug_windowing_unmap_toplevel (GtkPlug *plug);
  */
 void _gtk_plug_windowing_set_focus (GtkPlug *plug);
 
-/**
+/*
  * _gtk_plug_windowing_add_grabbed_key:
  *
  * @plug: a #GtkPlug
@@ -99,7 +99,7 @@ void _gtk_plug_windowing_add_grabbed_key (GtkPlug         *plug,
                                          guint            accelerator_key,
                                          GdkModifierType  accelerator_mods);
 
-/**
+/*
  * _gtk_plug_windowing_remove_grabbed_key:
  *
  * @plug: a #GtkPlug
@@ -113,7 +113,7 @@ void _gtk_plug_windowing_remove_grabbed_key (GtkPlug         *plug,
                                             guint            accelerator_key,
                                             GdkModifierType  accelerator_mods);
 
-/**
+/*
  * _gtk_plug_windowing_focus_to_parent:
  *
  * @plug: a #GtkPlug
@@ -125,7 +125,7 @@ void _gtk_plug_windowing_remove_grabbed_key (GtkPlug         *plug,
 void _gtk_plug_windowing_focus_to_parent (GtkPlug         *plug,
                                          GtkDirectionType direction);
 
-/**
+/*
  * _gtk_plug_windowing_filter_func:
  *
  * @gdk_xevent: a windowing system native event

diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c
index af66729067686c92703ecba0a0c057b32f4c2a92..ce0c0a6fad9f52f84d2c7f5ea55eeb545b3d96fc 100644 (file)
--- a/gtk/gtksocket.c
+++ b/gtk/gtksocket.c
@@ -84,7 +84,7 @@ enum {
 
 static guint socket_signals[LAST_SIGNAL] = { 0 };
 
-/**
+/*
  * _gtk_socket_get_private:
  *
  * @socket: a #GtkSocket

diff --git a/gtk/gtksocketprivate.h b/gtk/gtksocketprivate.h
index 85852fb8d34b14653361f9f2939d6c2586359315..44a6c6b36ed768609a8c4d3461c6cae1ea1cdebe 100644 (file)
--- a/gtk/gtksocketprivate.h
+++ b/gtk/gtksocketprivate.h
@@ -56,7 +56,7 @@ void _gtk_socket_advance_toplevel_focus (GtkSocket        *socket,
 
 /* In backend-specific file: */
 
-/**
+/*
  * _gtk_socket_windowing_get_id:
  *
  * @socket: a #GtkSocket
@@ -65,25 +65,25 @@ void _gtk_socket_advance_toplevel_focus (GtkSocket        *socket,
  */
 GdkNativeWindow _gtk_socket_windowing_get_id (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_realize_window:
  *
  */
 void _gtk_socket_windowing_realize_window (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_end_embedding_toplevel:
  *
  */
 void _gtk_socket_windowing_end_embedding_toplevel (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_size_request:
  *
  */
 void _gtk_socket_windowing_size_request (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_send_key_event:
  *
  */
@@ -91,41 +91,41 @@ void _gtk_socket_windowing_send_key_event (GtkSocket *socket,
                                           GdkEvent  *gdk_event,
                                           gboolean   mask_key_presses);
 
-/**
+/*
  * _gtk_socket_windowing_focus_change:
  *
  */
 void _gtk_socket_windowing_focus_change (GtkSocket *socket,
                                         gboolean   focus_in);
 
-/**
+/*
  * _gtk_socket_windowing_update_active:
  *
  */
 void _gtk_socket_windowing_update_active (GtkSocket *socket,
                                          gboolean   active);
 
-/**
+/*
  * _gtk_socket_windowing_update_modality:
  *
  */
 void _gtk_socket_windowing_update_modality (GtkSocket *socket,
                                            gboolean   modality);
 
-/**
+/*
  * _gtk_socket_windowing_focus:
  *
  */
 void _gtk_socket_windowing_focus (GtkSocket *socket,
                                  GtkDirectionType direction);
 
-/**
+/*
  * _gtk_socket_windowing_send_configure_event:
  *
  */
 void _gtk_socket_windowing_send_configure_event (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_select_plug_window_input:
  *
  * Asks the windowing system to send necessary events related to the
@@ -134,7 +134,7 @@ void _gtk_socket_windowing_send_configure_event (GtkSocket *socket);
  */
 void _gtk_socket_windowing_select_plug_window_input (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_embed_get_info:
  *
  * Gets whatever information necessary about an out-of-process plug
@@ -142,25 +142,25 @@ void _gtk_socket_windowing_select_plug_window_input (GtkSocket *socket);
  */
 void _gtk_socket_windowing_embed_get_info (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_embed_notify:
  *
  */
 void _gtk_socket_windowing_embed_notify (GtkSocket *socket);
 
-/**
+/*
  * _gtk_socket_windowing_embed_get_focus_wrapped:
  *
  */
 gboolean _gtk_socket_windowing_embed_get_focus_wrapped (void);
 
-/**
+/*
  * _gtk_socket_windowing_embed_set_focus_wrapped:
  *
  */
 void _gtk_socket_windowing_embed_set_focus_wrapped (void);
 
-/**
+/*
  * _gtk_socket_windowing_filter_func:
  *
  */

diff --git a/gtk/gtktable.c b/gtk/gtktable.c
index 9002ad3c6c983eac6fe418b315149150efd508c0..6a21603868cae721a9bee7da6b594130d192749d 100644 (file)
--- a/gtk/gtktable.c
+++ b/gtk/gtktable.c
@@ -714,7 +714,7 @@ gtk_table_set_row_spacings (GtkTable *table,
  * the spacing that will be used for newly added rows.
  * (See gtk_table_set_row_spacings())
  *
- * Returns value: the default row spacing
+ * Return value: the default row spacing
  **/
 guint
 gtk_table_get_default_row_spacing (GtkTable *table)
@@ -750,7 +750,7 @@ gtk_table_set_col_spacings (GtkTable *table,
  * the spacing that will be used for newly added columns.
  * (See gtk_table_set_col_spacings())
  *
- * Returns value: the default column spacing
+ * Return value: the default column spacing
  **/
 guint
 gtk_table_get_default_col_spacing (GtkTable *table)